home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_gtk+.idb / usr / freeware / info / gtk.info-4.z / gtk.info-4
Encoding:
GNU Info File  |  1999-07-16  |  49.6 KB  |  1,651 lines
  1. This is Info file gtk.info, produced by Makeinfo version 1.68 from the
  2. input file gtk.texi.
  3.  
  4.    This file documents GTK, the GIMP Toolkit
  5.  
  6.    Copyright (C) 1996 Peter Mattis Copyright (C) 1997 Peter Mattis
  7.  
  8.    Permission is granted to make and distribute verbatim copies of this
  9. manual provided the copyright notice and this permission notice are
  10. preserved on all copies
  11.  
  12.    Permission is granted to copy and distribute modified versions of
  13. this manual under the conditions for verbatim copying, provided that the
  14. entire resulting derived work is distributed under the terms of a
  15. permission notice identical to this one.
  16.  
  17.    Permission is granted to copy and distribute translations of this
  18. manual into another language, under the above conditions for modified
  19. versions, except that this permission notice may be stated in a
  20. translation approved by Peter Mattis.
  21.  
  22. INFO-DIR-SECTION User Interface Toolkit
  23. START-INFO-DIR-ENTRY
  24. * GTK: (gtk).        The GIMP Toolkit
  25. END-INFO-DIR-ENTRY
  26.  
  27. 
  28. File: gtk.info,  Node: GtkScrolledWindow,  Next: GtkSeparator,  Prev: GtkScrollbar,  Up: Widgets
  29.  
  30. The scrolled window widget
  31. ==========================
  32.  
  33. Description
  34. -----------
  35.  
  36. Options
  37. -------
  38.  
  39. Signals
  40. -------
  41.  
  42. Functions
  43. ---------
  44.  
  45.  - Function: guint gtk_scrolled_window_get_type (void)
  46.      Returns the `GtkScrolledWindow' type identifier.
  47.  
  48.  - Function: GtkWidget* gtk_scrolled_window_new (GtkAdjustment
  49.           *HADJUSTMENT, GtkAdjustment *VADJUSTMENT)
  50.      Create a new `GtkScrolledWindow' object initializing it with the
  51.      values in ADJUSTMENT and ADJUSTMENT. The new widget is returned as
  52.      a pointer to a `GtkWidget' object. `NULL' is returned on failure.
  53.  
  54.  - Function: GtkAdjustment* gtk_scrolled_window_get_hadjustment
  55.           (GtkScrolledWindow *SCROLLED_WINDOW)
  56.  
  57.  - Function: GtkAdjustment* gtk_scrolled_window_get_vadjustment
  58.           (GtkScrolledWindow *SCROLLED_WINDOW)
  59.  
  60.  - Function: void gtk_scrolled_window_set_policy (GtkScrolledWindow
  61.           *SCROLLED_WINDOW, GtkPolicyType HSCROLLBAR_POLICY,
  62.           GtkPolicyType VSCROLLBAR_POLICY)
  63.  
  64.  - Function: GtkScrolledWindow* GTK_SCROLLED_WINDOW (gpointer OBJ)
  65.      Cast a generic pointer to `GtkScrolledWindow*'. *Note Standard
  66.      Macros::, for more info.
  67.  
  68.  - Function: GtkScrolledWindowClass* GTK_SCROLLED_WINDOW_CLASS
  69.           (gpointer CLASS)
  70.      Cast a generic pointer to `GtkScrolledWindowClass*'. *Note
  71.      Standard Macros::, for more info.
  72.  
  73.  - Function: gint GTK_IS_SCROLLED_WINDOW (gpointer OBJ)
  74.      Determine if a generic pointer refers to a `GtkScrolledWindow'
  75.      object. *Note Standard Macros::, for more info.
  76.  
  77. 
  78. File: gtk.info,  Node: GtkSeparator,  Next: GtkStatusbar,  Prev: GtkScrolledWindow,  Up: Widgets
  79.  
  80. The separator widget
  81. ====================
  82.  
  83. Description
  84. -----------
  85.  
  86. Options
  87. -------
  88.  
  89. Signals
  90. -------
  91.  
  92. Functions
  93. ---------
  94.  
  95.  - Function: guint gtk_separator_get_type (void)
  96.      Returns the `GtkSeparator' type identifier.
  97.  
  98.  - Function: GtkSeparator* GTK_SEPARATOR (gpointer OBJ)
  99.      Cast a generic pointer to `GtkSeparator*'. *Note Standard
  100.      Macros::, for more info.
  101.  
  102.  - Function: GtkSeparatorClass* GTK_SEPARATOR_CLASS (gpointer CLASS)
  103.      Cast a generic pointer to `GtkSeparatorClass*'. *Note Standard
  104.      Macros::, for more info.
  105.  
  106.  - Function: gint GTK_IS_SEPARATOR (gpointer OBJ)
  107.      Determine if a generic pointer refers to a `GtkSeparator' object.
  108.      *Note Standard Macros::, for more info.
  109.  
  110. 
  111. File: gtk.info,  Node: GtkStatusbar,  Next: GtkTable,  Prev: GtkSeparator,  Up: Widgets
  112.  
  113. The statusbar widget
  114. ====================
  115.  
  116. Description
  117. -----------
  118.  
  119. Options
  120. -------
  121.  
  122. Signals
  123. -------
  124.  
  125. Functions
  126. ---------
  127.  
  128.  - Function: guint gtk_statusbar_get_type (void)
  129.      Returns the `GtkStatusbar' type identifier.
  130.  
  131.  - Function: GtkWidget* gtk_statusbar_new (void)
  132.      Create a new `GtkStatusbar' object returning the new widget as a
  133.      pointer to a `GtkWidget' object. `NULL' is returned on failure.
  134.  
  135.  - Function: gint gtk_statusbar_push (GtkStatusbar *STATUSBAR, gchar
  136.           *TEXT)
  137.  
  138.  - Function: void gtk_statusbar_pop (GtkStatusbar *STATUSBAR, gint
  139.           CONTEXT_ID)
  140.  
  141.  - Function: GtkStatusbar* GTK_STATUSBAR (gpointer OBJ)
  142.      Cast a generic pointer to `GtkStatusbar*'. *Note Standard
  143.      Macros::, for more info.
  144.  
  145.  - Function: GtkStatusbarClass* GTK_STATUSBAR_CLASS (gpointer CLASS)
  146.      Cast a generic pointer to `GtkStatusbarClass*'. *Note Standard
  147.      Macros::, for more info.
  148.  
  149.  - Function: gint GTK_IS_STATUSBAR (gpointer OBJ)
  150.      Determine if a generic pointer refers to a `GtkStatusbar' object.
  151.      *Note Standard Macros::, for more info.
  152.  
  153. 
  154. File: gtk.info,  Node: GtkTable,  Next: GtkText,  Prev: GtkStatusbar,  Up: Widgets
  155.  
  156. The table widget
  157. ================
  158.  
  159. Description
  160. -----------
  161.  
  162. Options
  163. -------
  164.  
  165.  - User Option: rows
  166.  
  167.  - User Option: columns
  168.  
  169.  - User Option: homogeneous
  170.      This option controls whether all child widgets in the `GtkTable'
  171.      will be of the same size. The child widgets will be the size of
  172.      the largest child.
  173.  
  174. Signals
  175. -------
  176.  
  177. Functions
  178. ---------
  179.  
  180.  - Function: guint gtk_table_get_type (void)
  181.      Returns the `GtkTable' type identifier.
  182.  
  183.  - Function: GtkWidget* gtk_table_new (gint ROWS, gint COLUMNS, gint
  184.           HOMOGENEOUS)
  185.      Create a new `GtkTable' object initializing it with the values in
  186.      ROWS, COLUMNS and HOMOGENEOUS. The new widget is returned as a
  187.      pointer to a `GtkWidget'. `NULL' is returned on failure.
  188.  
  189.  - Function: void gtk_table_attach (GtkTable *TABLE, GtkWidget *CHILD,
  190.           gint LEFT_ATTACH, gint RIGHT_ATTACH, gint TOP_ATTACH, gint
  191.           BOTTOM_ATTACH, gint XOPTIONS, gint YOPTIONS, gint XPADDING,
  192.           gint YPADDING)
  193.  
  194.  - Function: void gtk_table_attach_defaults (GtkTable *TABLE, GtkWidget
  195.           *WIDGET, gint LEFT_ATTACH, gint RIGHT_ATTACH, gint
  196.           TOP_ATTACH, gint BOTTOM_ATTACH)
  197.  
  198.  - Function: void gtk_table_set_row_spacing (GtkTable *TABLE, gint ROW,
  199.           gint SPACING)
  200.  
  201.  - Function: void gtk_table_set_col_spacing (GtkTable *TABLE, gint COL,
  202.           gint SPACING)
  203.  
  204.  - Function: void gtk_table_set_row_spacings (GtkTable *TABLE, gint
  205.           SPACING)
  206.  
  207.  - Function: void gtk_table_set_col_spacings (GtkTable *TABLE, gint
  208.           SPACING)
  209.  
  210.  - Function: GtkTable* GTK_TABLE (gpointer OBJ)
  211.      Cast a generic pointer to `GtkTable*'. *Note Standard Macros::, for
  212.      more info.
  213.  
  214.  - Function: GtkTableClass* GTK_TABLE_CLASS (gpointer CLASS)
  215.      Cast a generic pointer to `GtkTableClass*'. *Note Standard
  216.      Macros::, for more info.
  217.  
  218.  - Function: gint GTK_IS_TABLE (gpointer OBJ)
  219.      Determine if a generic pointer refers to a `GtkTable' object.
  220.      *Note Standard Macros::, for more info.
  221.  
  222. 
  223. File: gtk.info,  Node: GtkText,  Next: GtkToggleButton,  Prev: GtkTable,  Up: Widgets
  224.  
  225. The text widget
  226. ===============
  227.  
  228. Description
  229. -----------
  230.  
  231. Signals
  232. -------
  233.  
  234. Functions
  235. ---------
  236.  
  237.  - Function: guint gtk_text_get_type (void)
  238.      Returns the `GtkText' type identifier.
  239.  
  240.  - Function: GtkWidget* gtk_text_new (GtkAdjustment *HADJ,
  241.           GtkAdjustment *VADJ);
  242.      Create a new `GtkText' object initializing it with the values in
  243.      HADJ and VADJ. The new widget is returned as a pointer to a
  244.      `GtkWidget'. `NULL' is returned on failure.
  245.  
  246.  - Function: void gtk_text_set_editable (GtkText *TEXT, gint EDITABLE)
  247.  
  248.  - Function: void gtk_text_set_adjustments (GtkText *TEXT,
  249.           GtkAdjustment *HADJ, GtkAdjustment *VADJ)
  250.  
  251.  - Function: void gtk_text_set_point (GtkText *TEXT, guint INDEX)
  252.  
  253.  - Function: guint gtk_text_get_point (GtkText *TEXT)
  254.  
  255.  - Function: guint gtk_text_get_length (GtkText *TEXT)
  256.  
  257.  - Function: void gtk_text_freeze (GtkText *TEXT)
  258.  
  259.  - Function: void gtk_text_thaw (GtkText *TEXT)
  260.  
  261.  - Function: void gtk_text_insert (GtkText *TEXT, GdkFont *FONT,
  262.           GdkColor *FORE, GdkColor *BACK, char *CHARS, gint LENGTH)
  263.  
  264.  - Function: gint gtk_text_forward_delete (GtkText *TEXT, guint NCHARS)
  265.  
  266.  - Function: gint gtk_text_backward_delete (GtkText *TEXT, guint NCHARS)
  267.  
  268.  - Function: GtkText* GTK_TEXT (gpointer OBJ)
  269.      Cast a generic pointer to `GtkText*'. *Note Standard Macros::, for
  270.      more info.
  271.  
  272.  - Function: GtkTextClass* GTK_TEXT_CLASS (gpointer CLASS)
  273.      Cast a generic pointer to `GtkTextClass*'. *Note Standard Macros::,
  274.      for more info.
  275.  
  276.  - Function: gint GTK_IS_TEXT (gpointer OBJ)
  277.      Determine if a generic pointer refers to a `GtkText' object. *Note
  278.      Standard Macros::, for more info.
  279.  
  280. 
  281. File: gtk.info,  Node: GtkToggleButton,  Next: GtkToolbar,  Prev: GtkText,  Up: Widgets
  282.  
  283. The toggle button widget
  284. ========================
  285.  
  286. Description
  287. -----------
  288.  
  289.    Another form of button (*note GtkButton::.) with two states: on and
  290. off.  The appearance is that of a button which stays pressed on the
  291. first click, and is released on the second click.
  292.  
  293. Options
  294. -------
  295.  
  296.  - User Option: state
  297.  
  298. Signals
  299. -------
  300.  
  301.  - Signal: void GtkToggleButton::toggled (GtkToggleButton
  302.           *TOGGLE_BUTTON)
  303.  
  304. Functions
  305. ---------
  306.  
  307.  - Function: guint gtk_toggle_button_get_type (void)
  308.      Returns the `GtkToggleButton' type identifier.
  309.  
  310.  - Function: GtkWidget* gtk_toggle_button_new (void)
  311.      Create a new `GtkToggleButton' object returning the new widget as a
  312.      pointer to a `GtkWidget' object. `NULL' is returned on failure.
  313.  
  314.  - Function: GtkWidget* gtk_toggle_button_new_with_label (gchar *LABEL)
  315.      Create a new `GtkToggleButton' object initializing it with the
  316.      values in LABEL. The new widget is returned as a pointer to a
  317.      `GtkWidget' object. `NULL' is returned on failure.
  318.  
  319.  - Function: void gtk_toggle_button_set_mode (GtkToggleButton
  320.           *TOGGLE_BUTTON, gint DRAW_INDICATOR)
  321.  
  322.  - Function: void gtk_toggle_button_set_state (GtkToggleButton
  323.           *TOGGLE_BUTTON, gint STATE)
  324.  
  325.  - Function: void gtk_toggle_button_toggled (GtkToggleButton
  326.           *TOGGLE_BUTTON)
  327.  
  328.  - Function: GtkToggleButton* GTK_TOGGLE_BUTTON (gpointer OBJ)
  329.      Cast a generic pointer to `GtkToggleButton*'. *Note Standard
  330.      Macros::, for more info.
  331.  
  332.  - Function: GtkToggleButtonClass* GTK_TOGGLE_BUTTON_CLASS (gpointer
  333.           CLASS)
  334.      Cast a generic pointer to `GtkToggleButtonClass*'. *Note Standard
  335.      Macros::, for more info.
  336.  
  337.  - Function: gint GTK_IS_TOGGLE_BUTTON (gpointer OBJ)
  338.      Determine if a generic pointer refers to a `GtkToggleButton'
  339.      object. *Note Standard Macros::, for more info.
  340.  
  341. 
  342. File: gtk.info,  Node: GtkToolbar,  Next: GtkTooltips,  Prev: GtkToggleButton,  Up: Widgets
  343.  
  344. The tool bar widget
  345. ===================
  346.  
  347. Description
  348. -----------
  349.  
  350. Options
  351. -------
  352.  
  353.  - User Option: orientation
  354.         * GTK_ORIENTATION_HORIZONTAL
  355.  
  356.         * GTK_ORIENTATION_VERTICAL
  357.  
  358.  - User Option: style
  359.         * GTK_TOOLBAR_ICONS
  360.  
  361.         * GTK_TOOLBAR_TEXT
  362.  
  363.         * GTK_TOOLBAR_BOTH
  364.  
  365.  - User Option: space_size
  366.  
  367. Signals
  368. -------
  369.  
  370. Functions
  371. ---------
  372.  
  373.  - Function: guint gtk_toolbar_get_type (void)
  374.      Returns the `GtkToolbar' type identifier.
  375.  
  376.  - Function: GtkWidget* gtk_toolbar_new (GtkOrientation ORIENTATION,
  377.           GtkToolbarStyle STYLE)
  378.      Create a new `GtkToolbar' object initializing it with the values
  379.      ORIENTATION and STYLE. `NULL' is returned on failure.
  380.  
  381.  - Function: void gtk_toolbar_append_item (GtkToolbar *TOOLBAR, char
  382.           *TEXT, char *TOOLTIP_TEXT, GtkPixmap *ICON, GtkSignalFunc
  383.           CALLBACK, gpointer USER_DATA)
  384.  
  385.  - Function: void gtk_toolbar_prepend_item (GtkToolbar *TOOLBAR, char
  386.           *TEXT, char *TOOLTIP_TEXT, GtkPixmap *ICON, GtkSignalFunc
  387.           CALLBACK, gpointer USER_DATA)
  388.  
  389.  - Function: void gtk_toolbar_insert_item (GtkToolbar *TOOLBAR, char
  390.           *TEXT, char *TOOLTIP_TEXT, GtkPixmap *ICON, GtkSignalFunc
  391.           CALLBACK, gpointer USER_DATA, gint POSITION)
  392.  
  393.  - Function: void gtk_toolbar_append_space (GtkToolbar *TOOLBAR)
  394.  
  395.  - Function: void gtk_toolbar_prepend_space (GtkToolbar *TOOLBAR)
  396.  
  397.  - Function: void gtk_toolbar_insert_space (GtkToolbar *TOOLBAR, gint
  398.           POSITION)
  399.  
  400.  - Function: void gtk_toolbar_set_orientation (GtkToolbar *TOOLBAR,
  401.           GtkOrientation ORIENTATION)
  402.  
  403.  - Function: void gtk_toolbar_set_style (GtkToolbar *TOOLBAR,
  404.           GtkToolbarStyle STYLE)
  405.      Set the STYLE of the TOOLBAR to STYLE.
  406.  
  407.  - Function: void gtk_toolbar_set_space_size (GtkToolbar *TOOLBAR, gint
  408.           SPACE_SIZE)
  409.  
  410.  - Function: void gtk_toolbar_set_tooltips (GtkToolbar *TOOLBAR, gint
  411.           ENABLE)
  412.  
  413.  - Function: GtkToolbar* GTK_TOOLBAR (gpointer OBJ)
  414.      Cast a generic pointer to `GtkToolbar*'. *Note Standard Macros::,
  415.      for more info.
  416.  
  417.  - Function: GtkToolbarClass* GTK_TOOLBAR_CLASS (gpointer CLASS)
  418.      Cast a generic pointer to `GtkToolbarClass*'. *Note Standard
  419.      Macros::, for more info.
  420.  
  421.  - Function: gint GTK_IS_TOOLBAR (gpointer OBJ)
  422.      Determine if a generic pointer refers to a `GtkToolbar' object.
  423.      *Note Standard Macros::, for more info.
  424.  
  425. 
  426. File: gtk.info,  Node: GtkTooltips,  Next: GtkTree,  Prev: GtkToolbar,  Up: Widgets
  427.  
  428. The tool tips widget
  429. ====================
  430.  
  431. Description
  432. -----------
  433.  
  434. Options
  435. -------
  436.  
  437. Signals
  438. -------
  439.  
  440. Functions
  441. ---------
  442.  
  443.  - Function: GtkTooltips* gtk_tooltips_new (void)
  444.      Create a new `GtkTooltips' object returning the new widget as a
  445.      pointer to a `GtkWidget' object. `NULL' is returned on failure.
  446.  
  447.  - Function: GtkTooltips* gtk_tooltips_ref (GtkTooltips *TOOLTIPS)
  448.  
  449.  - Function: void gtk_tooltips_unref (GtkTooltips *TOOLTIPS)
  450.  
  451.  - Function: void gtk_tooltips_free_string (gpointer DATA, gpointer
  452.           USER_DATA)
  453.  
  454.  - Function: void gtk_tooltips_enable (GtkTooltips *TOOLTIPS)
  455.  
  456.  - Function: void gtk_tooltips_disable (GtkTooltips *TOOLTIPS)
  457.  
  458.  - Function: void gtk_tooltips_set_delay (GtkTooltips *TOOLTIPS,
  459.           GtkWidget *WIDGET, gchar *TIPS_TEXT)
  460.  
  461.  - Function: void gtk_tooltips_set_colors (GtkTooltips *TOOLTIPS,
  462.           GdkColor *BACKGROUND, GdkColor *FOREGROUND)
  463.  
  464.  - Function: GtkTooltips* GTK_TOOLTIPS (gpointer OBJ)
  465.      Cast a generic pointer to `GtkTooltips*'. *Note Standard Macros::,
  466.      for more info.
  467.  
  468.  - Function: GtkTooltipsClass* GTK_TOOLTIPS_CLASS (gpointer CLASS)
  469.      Cast a generic pointer to `GtkTooltipsClass*'. *Note Standard
  470.      Macros::, for more info.
  471.  
  472.  - Function: gint GTK_IS_TOOLTIPS (gpointer OBJ)
  473.      Determine if a generic pointer refers to a `GtkTooltips' object.
  474.      *Note Standard Macros::, for more info.
  475.  
  476. 
  477. File: gtk.info,  Node: GtkTree,  Next: GtkTreeItem,  Prev: GtkTooltips,  Up: Widgets
  478.  
  479. The tree widget
  480. ===============
  481.  
  482. Description
  483. -----------
  484.  
  485. Options
  486. -------
  487.  
  488. Signals
  489. -------
  490.  
  491. Functions
  492. ---------
  493.  
  494.  - Function: guint gtk_tree_get_type (void)
  495.      Returns the `GtkTree' type identifier.
  496.  
  497.  - Function: GtkWidget* gtk_tree_new (void)
  498.      Create a new `GtkTree' object returning the new widget as a
  499.      pointer to a `GtkWidget' object. `NULL' is returned on failure.
  500.  
  501.  - Function: void gtk_tree_append (GtkTree *TREE, GtkWidget *CHILD)
  502.  
  503.  - Function: void gtk_tree_prepend (GtkTree *TREE, GtkWidget *CHILD)
  504.  
  505.  - Function: void gtk_tree_insert (GtkTree *TREE, GtkWidget *CHILD,
  506.           gint POSITION)
  507.  
  508.  - Function: gint gtk_tree_child_position (GtkTree *TREE, GtkWidget
  509.           *CHILD)
  510.  
  511.  - Function: void gtk_tree_clear_items (GtkTree *TREE, gint START, gint
  512.           END)
  513.  
  514.  - Function: void gtk_tree_remove_items (GtkTree *TREE, GList *ITEMS)
  515.  
  516.  - Function: void gtk_tree_select_child (GtkTree *TREE, GtkWidget
  517.           *CHILD)
  518.  
  519.  - Function: void gtk_tree_select_item (GtkTree *TREE, gint ITEM)
  520.  
  521.  - Function: void gtk_tree_unselect_child (GtkTree *TREE, GtkWidget
  522.           *CHILD)
  523.  
  524.  - Function: void gtk_tree_unselect_item (GtkTree *TREE, gint ITEM)
  525.  
  526.  - Function: void gtk_tree_set_selection_mode (GtkTree *TREE,
  527.           GtkSelectionMode MODE)
  528.  
  529.  - Function: void gtk_tree_set_view_mode (GtkTree *TREE,
  530.           GtkTreeViewMode MODE)
  531.  
  532.  - Function: void gtk_tree_set_view_lines (GtkTree *TREE, guint FLAG)
  533.  
  534.  - Function: GtkTree* GTK_TREE (gpointer OBJ)
  535.      Cast a generic pointer to `GtkTree*'. *Note Standard Macros::, for
  536.      more info.
  537.  
  538.  - Function: GtkTreeClass* GTK_TREE_CLASS (gpointer CLASS)
  539.      Cast a generic pointer to `GtkTreeClass*'. *Note Standard Macros::,
  540.      for more info.
  541.  
  542.  - Function: gint GTK_IS_TREE (gpointer OBJ)
  543.      Determine if a generic pointer refers to a `GtkTree' object. *Note
  544.      Standard Macros::, for more info.
  545.  
  546. 
  547. File: gtk.info,  Node: GtkTreeItem,  Next: GtkVBox,  Prev: GtkTree,  Up: Widgets
  548.  
  549. The tree item widget
  550. ====================
  551.  
  552. Description
  553. -----------
  554.  
  555. Options
  556. -------
  557.  
  558. Signals
  559. -------
  560.  
  561. Functions
  562. ---------
  563.  
  564.  - Function: guint gtk_tree_item_get_type (void)
  565.      Returns the `GtkTreeItem' type identifier.
  566.  
  567.  - Function: GtkWidget* gtk_tree_item_new (void)
  568.      Create a new `GtkTreeItem' object returning the new widget as a
  569.      pointer to a `GtkWidget' object. `NULL' is returned on failure.
  570.  
  571.  - Function: GtkWidget* gtk_tree_item_new_with_label (gchar *LABEL)
  572.      Create a new `GtkTreeItem' object initializing it with the values
  573.      in LABEL. The new widget is returned as a pointer to a `GtkWidget'
  574.      object. `NULL' is returned on failure.
  575.  
  576.  - Function: void gtk_tree_item_set_subtree (GtkTreeItem *TREE_ITEM,
  577.           GtkWidget *SUBTREE)
  578.  
  579.  - Function: void gtk_tree_item_select (GtkTreeItem *TREE_ITEM)
  580.  
  581.  - Function: void gtk_tree_item_deselect (GtkTreeItem *TREE_ITEM)
  582.  
  583.  - Function: void gtk_tree_item_expand (GtkTreeItem *TREE_ITEM)
  584.  
  585.  - Function: void gtk_tree_item_collapse (GtkTreeItem *TREE_ITEM)
  586.  
  587.  - Function: void gtk_tree_item_remove_subtree (GtkTreeItem *ITEM)
  588.  
  589.  - Function: GtkTreeItem* GTK_TREE_ITEM (gpointer OBJ)
  590.      Cast a generic pointer to `GtkTreeItem*'. *Note Standard Macros::,
  591.      for more info.
  592.  
  593.  - Function: GtkTreeItemClass* GTK_TREE_ITEM_CLASS (gpointer CLASS)
  594.      Cast a generic pointer to `GtkTreeItemClass*'. *Note Standard
  595.      Macros::, for more info.
  596.  
  597.  - Function: gint GTK_IS_TREE_ITEM (gpointer OBJ)
  598.      Determine if a generic pointer refers to a `GtkTreeItem' object.
  599.      *Note Standard Macros::, for more info.
  600.  
  601. 
  602. File: gtk.info,  Node: GtkVBox,  Next: GtkVButtonBox,  Prev: GtkTreeItem,  Up: Widgets
  603.  
  604. The vertical box widget
  605. =======================
  606.  
  607. Description
  608. -----------
  609.  
  610. Options
  611. -------
  612.  
  613.  - User Option: homogeneous
  614.      This option controls whether each object in the box has the same
  615.      size. In the case of the `GtkVBox', this refers to the height. If
  616.      this option is set then the EXPAND option to the `gtk_box_pack'
  617.      (*note GtkBox::.)  routines is always turned on.
  618.  
  619.  - User Option: spacing
  620.      This option sets the amount of space that is added between the
  621.      objects packed into this `GtkVBox' object.
  622.  
  623. Signals
  624. -------
  625.  
  626.    This widget does not define any new signals.
  627.  
  628. Functions
  629. ---------
  630.  
  631.  - Function: guint gtk_vbox_get_type (void)
  632.      Returns the `GtkVBox' type identifier.
  633.  
  634.  - Function: GtkWidget* gtk_vbox_new (gint HOMOGENEOUS, gint SPACING)
  635.      Create a new `GtkVBox' object initializing it with the values in
  636.      HOMOGENEOUS and SPACING. The new widget is returned as a pointer
  637.      to a `GtkWidget' object. `NULL' is returned on failure.
  638.  
  639.  - Function: GtkVBox* GTK_VBOX (gpointer OBJ)
  640.      Cast a generic pointer to `GtkVBox*'. *Note Standard Macros::, for
  641.      more info.
  642.  
  643.  - Function: GtkVBoxClass* GTK_VBOX_CLASS (gpointer CLASS)
  644.      Cast a generic pointer to `GtkVBoxClass*'. *Note Standard Macros::,
  645.      for more info.
  646.  
  647.  - Function: gint GTK_IS_VBOX (gpointer OBJ)
  648.      Determine if a generic pointer refers to a `GtkVBox' object. *Note
  649.      Standard Macros::, for more info.
  650.  
  651. 
  652. File: gtk.info,  Node: GtkVButtonBox,  Next: GtkViewport,  Prev: GtkVBox,  Up: Widgets
  653.  
  654. The vertical button box widget
  655. ==============================
  656.  
  657. Description
  658. -----------
  659.  
  660. Options
  661. -------
  662.  
  663.  - User Option: spacing
  664.  
  665.  - User Option: layout
  666.  
  667. Signals
  668. -------
  669.  
  670. Functions
  671. ---------
  672.  
  673.  - Function: guint gtk_vbutton_box_get_type (void)
  674.      Returns the `GtkVButtonBox' type identifier.
  675.  
  676.  - Function: GtkWidget* gtk_vbutton_box_new (void)
  677.      Create a new `GtkVButtonBox' object returning the new widget as a
  678.      pointer to a `GtkWidget' object. `NULL' is returned on failure.
  679.  
  680.  - Function: void gtk_vbutton_box_set_spacing_default (gint SPACING)
  681.  
  682.  - Function: void gtk_vbutton_box_set_layout_default (gint LAYOUT)
  683.  
  684.  - Function: gint gtk_vbutton_box_get_spacing_default (void)
  685.  
  686.  - Function: gint gtk_vbutton_box_get_layout_default (void)
  687.  
  688.  - Function: GtkVButtonBox* GTK_VBUTTON_BOX (gpointer OBJ)
  689.      Cast a generic pointer to `GtkVButtonBox*'. *Note Standard
  690.      Macros::, for more info.
  691.  
  692.  - Function: GtkVButtonBoxClass* GTK_VBUTTON_BOX_CLASS (gpointer CLASS)
  693.      Cast a generic pointer to `GtkVButtonBoxClass*'. *Note Standard
  694.      Macros::, for more info.
  695.  
  696.  - Function: gint GTK_IS_VBUTTON_BOX (gpointer OBJ)
  697.      Determine if a generic pointer refers to a `GtkVButtonBox' object.
  698.      *Note Standard Macros::, for more info.
  699.  
  700. 
  701. File: gtk.info,  Node: GtkViewport,  Next: GtkVPaned,  Prev: GtkVButtonBox,  Up: Widgets
  702.  
  703. The viewport widget
  704. ===================
  705.  
  706. Description
  707. -----------
  708.  
  709. Signals
  710. -------
  711.  
  712. Functions
  713. ---------
  714.  
  715.  - Function: guint gtk_viewport_get_type (void)
  716.      Returns the `GtkViewport' type identifier.
  717.  
  718.  - Function: GtkWidget* gtk_viewport_new (GtkAdjustment *HADJUSTMENT,
  719.           GtkAdjustment *VADJUSTMENT)
  720.  
  721.  - Function: GtkAdjustment* gtk_viewport_get_hadjustment (GtkViewport
  722.           *VIEWPORT)
  723.  
  724.  - Function: GtkAdjustment* gtk_viewport_get_vadjustment (GtkViewport
  725.           *VIEWPORT)
  726.  
  727.  - Function: void gtk_viewport_set_hadjustment (GtkViewport *VIEWPORT,
  728.           GtkAdjustment *ADJUSTMENT)
  729.  
  730.  - Function: void gtk_viewport_set_vadjustment (GtkViewport *VIEWPORT,
  731.           GtkAdjustment *ADJUSTMENT)
  732.  
  733.  - Function: void gtk_viewport_set_shadow_type (GtkViewport *VIEWPORT,
  734.           GtkShadowType TYPE)
  735.  
  736.  - Function: GtkViewport* GTK_VIEWPORT (gpointer OBJ)
  737.      Cast a generic pointer to `GtkViewport*'. *Note Standard Macros::,
  738.      for more info.
  739.  
  740.  - Function: GtkViewportClass* GTK_VIEWPORT_CLASS (gpointer CLASS)
  741.      Cast a generic pointer to `GtkViewportClass*'. *Note Standard
  742.      Macros::, for more info.
  743.  
  744.  - Function: gint GTK_IS_VIEWPORT (gpointer OBJ)
  745.      Determine if a generic pointer refers to a `GtkViewport' object.
  746.      *Note Standard Macros::, for more info.
  747.  
  748. 
  749. File: gtk.info,  Node: GtkVPaned,  Next: GtkVRuler,  Prev: GtkViewport,  Up: Widgets
  750.  
  751. The vertical paned widget
  752. =========================
  753.  
  754. Description
  755. -----------
  756.  
  757. Options
  758. -------
  759.  
  760. Signals
  761. -------
  762.  
  763. Functions
  764. ---------
  765.  
  766.  - Function: guint gtk_vpaned_get_type (void)
  767.      Returns the `GtkVPaned' type identifier.
  768.  
  769.  - Function: GtkWidget* gtk_vpaned_new (void)
  770.      Create a new `GtkVPaned' object returning the new widget as a
  771.      pointer to a `GtkWidget' object. `NULL' is returned on failure.
  772.  
  773.  - Function: GtkVPaned* GTK_VPANED (gpointer OBJ)
  774.      Cast a generic pointer to `GtkVPaned*'. *Note Standard Macros::,
  775.      for more info.
  776.  
  777.  - Function: GtkVPanedClass* GTK_VPANED_CLASS (gpointer CLASS)
  778.      Cast a generic pointer to `GtkVPanedClass*'. *Note Standard
  779.      Macros::, for more info.
  780.  
  781.  - Function: gint GTK_IS_VPANED (gpointer OBJ)
  782.      Determine if a generic pointer refers to a `GtkVPaned' object.
  783.      *Note Standard Macros::, for more info.
  784.  
  785. 
  786. File: gtk.info,  Node: GtkVRuler,  Next: GtkVScale,  Prev: GtkVPaned,  Up: Widgets
  787.  
  788. The vertical ruler widget
  789. =========================
  790.  
  791. Description
  792. -----------
  793.  
  794. Options
  795. -------
  796.  
  797. Signals
  798. -------
  799.  
  800. Functions
  801. ---------
  802.  
  803.  - Function: guint gtk_vruler_get_type (void)
  804.      Returns the `GtkVRuler' type identifier.
  805.  
  806.  - Function: GtkWidget* gtk_vruler_new (void)
  807.      Create a new `GtkVRuler' object returning the new widget as a
  808.      pointer to a `GtkWidget' object. `NULL' is returned on failure.
  809.  
  810.  - Function: GtkVRuler* GTK_VRULER (gpointer OBJ)
  811.      Cast a generic pointer to `GtkVRuler*'. *Note Standard Macros::,
  812.      for more info.
  813.  
  814.  - Function: GtkVRulerClass* GTK_VRULER_CLASS (gpointer CLASS)
  815.      Cast a generic pointer to `GtkVRulerClass*'. *Note Standard
  816.      Macros::, for more info.
  817.  
  818.  - Function: gint GTK_IS_VRULER (gpointer OBJ)
  819.      Determine if a generic pointer refers to a `GtkVRuler' object.
  820.      *Note Standard Macros::, for more info.
  821.  
  822. 
  823. File: gtk.info,  Node: GtkVScale,  Next: GtkVScrollbar,  Prev: GtkVRuler,  Up: Widgets
  824.  
  825. The vertical ruler widget
  826. =========================
  827.  
  828. Description
  829. -----------
  830.  
  831. Options
  832. -------
  833.  
  834. Signals
  835. -------
  836.  
  837. Functions
  838. ---------
  839.  
  840.  - Function: guint gtk_vscale_get_type (void)
  841.      Returns the `GtkVScale' type identifier.
  842.  
  843.  - Function: GtkWidget* gtk_vscale_new (GtkAdjustment *ADJUSTMENT)
  844.      Create a new `GtkVScale' object returning the new widget as a
  845.      pointer to a `GtkWidget' object. `NULL' is returned on failure.
  846.  
  847.  - Function: GtkVScale* GTK_VSCALE (gpointer OBJ)
  848.      Cast a generic pointer to `GtkVScale*'. *Note Standard Macros::,
  849.      for more info.
  850.  
  851.  - Function: GtkVScaleClass* GTK_VSCALE_CLASS (gpointer CLASS)
  852.      Cast a generic pointer to `GtkVScaleClass*'. *Note Standard
  853.      Macros::, for more info.
  854.  
  855.  - Function: gint GTK_IS_VSCALE (gpointer OBJ)
  856.      Determine if a generic pointer refers to a `GtkVScale' object.
  857.      *Note Standard Macros::, for more info.
  858.  
  859. 
  860. File: gtk.info,  Node: GtkVScrollbar,  Next: GtkVSeparator,  Prev: GtkVScale,  Up: Widgets
  861.  
  862. The vertical scrollbar widget
  863. =============================
  864.  
  865. Description
  866. -----------
  867.  
  868. Options
  869. -------
  870.  
  871. Signals
  872. -------
  873.  
  874. Functions
  875. ---------
  876.  
  877.  - Function: guint gtk_vscrollbar_get_type (void)
  878.      Returns the `GtkVScrollbar' type identifier.
  879.  
  880.  - Function: GtkWidget* gtk_vscrollbar_new (GtkAdjustment *ADJUSTMENT)
  881.      Create a new `GtkVScrollbar' object initializing it with the
  882.      values in ADJUSTMENT. The new widget is returned as a pointer to a
  883.      `GtkWidget' object. `NULL' is returned on failure.
  884.  
  885.  - Function: GtkVScrollbar* GTK_VSCROLLBAR (gpointer OBJ)
  886.      Cast a generic pointer to `GtkVScrollbar*'. *Note Standard
  887.      Macros::, for more info.
  888.  
  889.  - Function: GtkVScrollbarClass* GTK_VSCROLLBAR_CLASS (gpointer CLASS)
  890.      Cast a generic pointer to `GtkVScrollbarClass*'. *Note Standard
  891.      Macros::, for more info.
  892.  
  893.  - Function: gint GTK_IS_VSCROLLBAR (gpointer OBJ)
  894.      Determine if a generic pointer refers to a `GtkVScrollbar' object.
  895.      *Note Standard Macros::, for more info.
  896.  
  897. 
  898. File: gtk.info,  Node: GtkVSeparator,  Next: GtkWidget,  Prev: GtkVScrollbar,  Up: Widgets
  899.  
  900. The vertical separator widget
  901. =============================
  902.  
  903. Description
  904. -----------
  905.  
  906. Signals
  907. -------
  908.  
  909. Functions
  910. ---------
  911.  
  912.  - Function: guint gtk_vseparator_get_type (void)
  913.      Returns the `GtkVSeparator' type identifier.
  914.  
  915.  - Function: GtkWidget* gtk_vseparator_new (void)
  916.      Create a new `GtkVSeparator' object and return the new widget as a
  917.      pointer to a `GtkWidget' object. `NULL' is returned on failure.
  918.  
  919.  - Function: GtkVSeparator* GTK_VSEPARATOR (gpointer OBJ)
  920.      Cast a generic pointer to `GtkVSeparator*'. *Note Standard
  921.      Macros::, for more info.
  922.  
  923.  - Function: GtkVSeparatorClass* GTK_VSEPARATOR_CLASS (gpointer CLASS)
  924.      Cast a generic pointer to `GtkVSeparatorClass*'. *Note Standard
  925.      Macros::, for more info.
  926.  
  927.  - Function: gint GTK_IS_VSEPARATOR (gpointer OBJ)
  928.      Determine if a generic pointer refers to a `GtkVSeparator' object.
  929.      *Note Standard Macros::, for more info.
  930.  
  931. 
  932. File: gtk.info,  Node: GtkWidget,  Next: GtkWindow,  Prev: GtkVSeparator,  Up: Widgets
  933.  
  934. The base widget
  935. ===============
  936.  
  937. Description
  938. -----------
  939.  
  940. Signals
  941. -------
  942.  
  943.  - Signal: void GtkWidget::show (GtkWidget *WIDGET)
  944.  
  945.  - Signal: void GtkWidget::hide (GtkWidget *WIDGET)
  946.  
  947.  - Signal: void GtkWidget::map (GtkWidget *WIDGET)
  948.  
  949.  - Signal: void GtkWidget::unmap (GtkWidget *WIDGET)
  950.  
  951.  - Signal: void GtkWidget::realize (GtkWidget *WIDGET)
  952.  
  953.  - Signal: void GtkWidget::unrealize (GtkWidget *WIDGET)
  954.  
  955.  - Signal: void GtkWidget::draw (GtkWidget *WIDGET, GdkRectangle *AREA)
  956.  
  957.  - Signal: void GtkWidget::draw_focus (GtkWidget *WIDGET)
  958.  
  959.  - Signal: void GtkWidget::draw_default (GtkWidget *WIDGET)
  960.  
  961.  - Signal: void GtkWidget::size_request (GtkWidget *WIDGET,
  962.           GtkRequisition *REQUISITION)
  963.  
  964.  - Signal: void GtkWidget::size_allocate (GtkWidget *WIDGET,
  965.           GtkAllocation *ALLOCATION)
  966.  
  967.  - Signal: void GtkWidget::state_changed (GtkWidget *WIDGET)
  968.  
  969.  - Signal: gint GtkWidget::install_accelerator (GtkWidget *WIDGET,
  970.           gchar *SIGNAL_NAME, gchar KEY, guint8 MODIFIERS)
  971.  
  972.  - Signal: void GtkWidget::remove_accelerator (GtkWidget *WIDGET, gchar
  973.           *SIGNAL_NAME)
  974.  
  975.  - Signal: gint GtkWidget::event (GtkWidget *WIDGET, GdkEvent *EVENT)
  976.  
  977.  - Signal: gint GtkWidget::button_press_event (GtkWidget *WIDGET,
  978.           GdkEventButton *EVENT)
  979.  
  980.  - Signal: gint GtkWidget::button_release_event (GtkWidget *WIDGET,
  981.           GdkEventButton *EVENT)
  982.  
  983.  - Signal: gint GtkWidget::motion_notify_event (GtkWidget *WIDGET,
  984.           GdkEventMotion *EVENT)
  985.  
  986.  - Signal: gint GtkWidget::delete_event (GtkWidget *WIDGET, GdkEventAny
  987.           *EVENT)
  988.  
  989.  - Signal: gint GtkWidget::destroy_event (GtkWidget *WIDGET,
  990.           GdkEventAny *EVENT)
  991.  
  992.  - Signal: gint GtkWidget::expose_event (GtkWidget *WIDGET,
  993.           GdkEventExpose *EVENT)
  994.  
  995.  - Signal: gint GtkWidget::key_press_event (GtkWidget *WIDGET,
  996.           GdkEventKey *EVENT)
  997.  
  998.  - Signal: gint GtkWidget::key_release_event (GtkWidget *WIDGET,
  999.           GdkEventKey *EVENT)
  1000.  
  1001.  - Signal: gint GtkWidget::enter_notify_event (GtkWidget *WIDGET,
  1002.           GdkEventCrossing *EVENT)
  1003.  
  1004.  - Signal: gint GtkWidget::leave_notify_event (GtkWidget *WIDGET,
  1005.           GdkEventCrossing *EVENT)
  1006.  
  1007.  - Signal: gint GtkWidget::configure_event (GtkWidget *WIDGET,
  1008.           GdkEventConfigure *EVENT)
  1009.  
  1010.  - Signal: gint GtkWidget::focus_in_event (GtkWidget *WIDGET,
  1011.           GdkEventFocus *EVENT)
  1012.  
  1013.  - Signal: gint GtkWidget::focus_out_event (GtkWidget *WIDGET,
  1014.           GdkEventFocus *EVENT)
  1015.  
  1016.  - Signal: gint GtkWidget::map_event (GtkWidget *WIDGET, GdkEventAny
  1017.           *EVENT)
  1018.  
  1019.  - Signal: gint GtkWidget::unmap_event (GtkWidget *WIDGET, GdkEventAny
  1020.           *EVENT)
  1021.  
  1022.  - Signal: gint GtkWidget::property_notify_event (GtkWidget *WIDGET,
  1023.           GdkEventProperty *EVENT)
  1024.  
  1025.  - Signal: gint GtkWidget::selection_clear_event (GtkWidget *WIDGET,
  1026.           GdkEventSelection *EVENT)
  1027.  
  1028.  - Signal: gint GtkWidget::selection_request_event (GtkWidget *WIDGET,
  1029.           GdkEventSelection *EVENT)
  1030.  
  1031.  - Signal: gint GtkWidget::selection_notify_event (GtkWidget *WIDGET,
  1032.           GdkEventSelection *EVENT)
  1033.  
  1034.  - Signal: gint GtkWidget::drop_event (GtkWidget *WIDGET, GdkEventDrop
  1035.           *EVENT)
  1036.  
  1037.  - Signal: gint GtkWidget::drag_begin_event (GtkWidget *WIDGET,
  1038.           GdkEventDragBegin *EVENT)
  1039.  
  1040.  - Signal: gint GtkWidget::other_event (GtkWidget *WIDGET,
  1041.           GdkEventOther *EVENT)
  1042.  
  1043. Functions
  1044. ---------
  1045.  
  1046.  - Function: guint gtk_widget_get_type (void)
  1047.      Returns the `GtkWidget' type identifier.
  1048.  
  1049.  - Function: void gtk_widget_class_init (GtkWidgetClass *CLASS)
  1050.  
  1051.  - Function: void gtk_widget_init (GtkWidget *WIDGET)
  1052.  
  1053.  - Function: void gtk_widget_destroy (GtkWidget *WIDGET)
  1054.  
  1055.  - Function: void gtk_widget_show (GtkWidget *WIDGET)
  1056.  
  1057.  - Function: void gtk_widget_hide (GtkWidget *WIDGET)
  1058.  
  1059.  - Function: void gtk_widget_map (GtkWidget *WIDGET)
  1060.  
  1061.  - Function: void gtk_widget_unmap (GtkWidget *WIDGET)
  1062.  
  1063.  - Function: void gtk_widget_realize (GtkWidget *WIDGET)
  1064.  
  1065.  - Function: void gtk_widget_unrealize (GtkWidget *WIDGET)
  1066.  
  1067.  - Function: void gtk_widget_draw (GtkWidget *WIDGET, GdkRectangle
  1068.           *AREA)
  1069.  
  1070.  - Function: void gtk_widget_draw_focus (GtkWidget *WIDGET)
  1071.  
  1072.  - Function: void gtk_widget_draw_children (GtkWidget *WIDGET)
  1073.  
  1074.  - Function: void gtk_widget_size_request (GtkWidget *WIDGET,
  1075.           GtkRequisition *REQUISITION)
  1076.  
  1077.  - Function: void gtk_widget_size_allocate (GtkWidget *WIDGET,
  1078.           GtkAllocation *ALLOCATION)
  1079.  
  1080.  - Function: void gtk_widget_install_accelerator (GtkWidget *WIDGET,
  1081.           GtkAcceleratorTable *TABLE, gchar *SIGNAL_NAME, gchar KEY,
  1082.           guint8 MODIFIERS)
  1083.  
  1084.  - Function: void gtk_widget_remove_accelerator (GtkWidget *WIDGET,
  1085.           GtkAcceleratorTable *TABLE, gchar *SIGNAL_NAME)
  1086.  
  1087.  - Function: gint gtk_widget_event (GtkWidget *WIDGET, GdkEvent *EVENT)
  1088.  
  1089.  - Function: void gtk_widget_reparent (GtkWidget *WIDGET, GtkWidget
  1090.           *NEW_PARENT)
  1091.  
  1092.  - Function: void gtk_widget_popup (GtkWidget *WIDGET, gint X, gint Y)
  1093.  
  1094.  - Function: gint gtk_widget_intersect (GtkWidget *WIDGET, GdkRectangle
  1095.           *AREA, GdkRectangle *INTERSECTION)
  1096.  
  1097.  - Function: void gtk_widget_grab_focus (GtkWidget *WIDGET)
  1098.  
  1099.  - Function: void gtk_widget_grab_default (GtkWidget *WIDGET)
  1100.  
  1101.  - Function: void gtk_widget_restore_state (GtkWidget *WIDGET)
  1102.  
  1103.  - Function: void gtk_widget_set_name (GtkWidget *WIDGET, gchar *NAME)
  1104.  
  1105.  - Function: void gtk_widget_set_state (GtkWidget *WIDGET, GtkStateType
  1106.           STATE)
  1107.  
  1108.  - Function: void gtk_widget_set_sensitive (GtkWidget *WIDGET, gint
  1109.           sensitive)
  1110.  
  1111.  - Function: void gtk_widget_set_parent (GtkWidget *WIDGET, GtkWidget
  1112.           *PARENT)
  1113.  
  1114.  - Function: void gtk_widget_set_style (GtkWidget *WIDGET, GtkStyle
  1115.           *STYLE)
  1116.  
  1117.  - Function: void gtk_widget_set_uposition (GtkWidget *WIDGET, gint X,
  1118.           gint Y)
  1119.  
  1120.  - Function: void gtk_widget_set_usize (GtkWidget *WIDGET, gint WIDTH,
  1121.           gint HEIGHT)
  1122.  
  1123.  - Function: GtkWidget* gtk_widget_get_toplevel (GtkWidget *WIDGET)
  1124.  
  1125.  - Function: GtkWidget* gtk_widget_get_ancestor (GtkWidget *WIDGET,
  1126.           gint TYPE)
  1127.  
  1128.  - Function: GdkColormap* gtk_widget_get_colormap (GtkWidget *WIDGET)
  1129.  
  1130.  - Function: GdkVisual* gtk_widget_get_visual (GtkWidget *VISUAL)
  1131.  
  1132.  - Function: GtkStyle* gtk_widget_get_style (GtkWidget *STYLE)
  1133.  
  1134.  - Function: GtkWidget* GTK_WIDGET (gpointer OBJ)
  1135.      Cast a generic pointer to `GtkWidget*'. *Note Standard Macros::,
  1136.      for more info.
  1137.  
  1138.  - Function: GtkWidgetClass* GTK_WIDGET_CLASS (gpointer CLASS)
  1139.      Cast a generic pointer to `GtkWidgetClass*'. *Note Standard
  1140.      Macros::, for more info.
  1141.  
  1142.  - Function: gint GTK_IS_WIDGET (gpointer OBJ)
  1143.      Determine if a generic pointer refers to a `GtkWidget' object.
  1144.      *Note Standard Macros::, for more info.
  1145.  
  1146. 
  1147. File: gtk.info,  Node: GtkWindow,  Prev: GtkWidget,  Up: Widgets
  1148.  
  1149. The window widget
  1150. =================
  1151.  
  1152. Description
  1153. -----------
  1154.  
  1155. Options
  1156. -------
  1157.  
  1158.  - User Option: type
  1159.      The TYPE options specify how this widget will interact with the
  1160.      window manager. Currently the following types and the effect they
  1161.      have on the window to window manager interaction is as follows.
  1162.         * `GTK_WINDOW_TOPLEVEL'
  1163.              * The option `GTK_WINDOW_TOPLEVEL' is usually used for the
  1164.                main application window that will remain for the entire
  1165.                application run.
  1166.  
  1167.         * `GTK_WINDOW_DIALOG'
  1168.              * The option `GTK_WINDOW_DIALOG' is usually used for
  1169.                transient windows. These windows will open up, gather
  1170.                some input or provide some application specific updates,
  1171.                then close. The window manager is free not to provide
  1172.                all the 'normal' window functions to this window.
  1173.  
  1174.         * `GTK_WINDOW_POPUP'
  1175.              * The option `GTK_WINDOW_POPUP' is usually used for
  1176.                transient windows.  These windows are typically used for
  1177.                when no user interaction is required, to notify the user
  1178.                of some condition. Other uses for these types of windows
  1179.                are for 'about windows', startup windows and the like.
  1180.                Typically the window manager will *not* provide the
  1181.                usual widgets that surround the window. At the most all
  1182.                that will be provided is a border. Also note that
  1183.                windows that set this TYPE will not be in any window
  1184.                list of the window manager. Though this window will
  1185.                *not* get the kill and close widgets of the window
  1186.                manager they still can receive said events and should be
  1187.                taken into account.
  1188.  
  1189.  - User Option: title
  1190.      The TITLE option will set the title of the window in the window
  1191.      manager.  *Note:* On windows that have the TYPE option set to
  1192.      `GTK_WINDOW_POPUP' there is a strong possibility that this will
  1193.      text will not be seen.
  1194.  
  1195.  - User Option: position
  1196.      The POSITION option will determine where the window will be
  1197.      displayed when it is finally drawn to the screen. Currently the
  1198.      following positions  and the effect they have on window placement
  1199.      can be specified.
  1200.  
  1201.         * `GTK_WIN_POS_NONE'
  1202.              * This POSITION type will allow the window manager full
  1203.                freedom, depending on the current settings in the window
  1204.                manager. As to where the window will be placed.
  1205.  
  1206.         * `GTK_WIN_POS_CENTER'
  1207.              * This POSITION option will cause the window to center
  1208.                itself on the the screen. This option setting will take
  1209.                into account the VIRTUAL SCREEN size when calculating
  1210.                the center. This is *not* the same as the VIRTUAL
  1211.                DESKTOP setting of many window managers. It will center
  1212.                itself on the current VIRTUAL DESKTOP.
  1213.  
  1214.         * `GTK_WIN_POS_MOUSE'
  1215.                This POSITION option will cause the window to center
  1216.                itself under the mouse pointers' current location.
  1217.                Typical uses for this setting is in
  1218.                warning/error/informational dialogs where user
  1219.                interaction is desired.
  1220.  
  1221. Signals
  1222. -------
  1223.  
  1224.  - Signal: void GtkWindow::move_resize (GtkWindow *WINDOW, gint *X,
  1225.           gint *Y, gint WIDTH, gint HEIGHT)
  1226.  
  1227.  - Signal: void GtkWindow::set_focus (GtkWindow *WINDOW, GtkWidget
  1228.           *FOCUS)
  1229.  
  1230. Functions
  1231. ---------
  1232.  
  1233.  - Function: guint gtk_window_get_type (void)
  1234.      Returns the `GtkWindow' type identifier.
  1235.  
  1236.  - Function: GtkWidget* gtk_window_new (GtkWindowType TYPE)
  1237.      Create a new `GtkWindow' object. The new widget is returned as a
  1238.      pointer to a `GtkWidget' object. `NULL' is returned on failure.
  1239.      The TYPE can be one of `GTK_WINDOW_TOPLEVEL', `GTK_WINDOW_DIALOG'
  1240.      or, `GTK_WINDOW_POPUP'. The TYPE value determines how this widget
  1241.      will interact with the window manager.
  1242.  
  1243.  - Function: void gtk_window_set_title (GtkWindow *WINDOW, gchar *TITLE)
  1244.      Set the title of this window to the text in the TITLE argument. It
  1245.      is important to not set the fields of the `GtkWindow' structure
  1246.      directly.
  1247.  
  1248.  - Function: void gtk_window_set_focus (GtkWindow *WINDOW, GtkWidget
  1249.           *FOCUS)
  1250.  
  1251.  - Function: void gtk_window_set_default (GtkWindow *WINDOW, GtkWidget
  1252.           *DEFAULTW)
  1253.  
  1254.  - Function: void gtk_window_set_policy (GtkWindow *WINDOW, gint
  1255.           ALLOW_SHRINK, gint ALLOW_GROW, gint AUTO_SHRINK)
  1256.  
  1257.  - Function: void gtk_window_add_accelerator_table (GtkWindow *WINDOW,
  1258.           GtkAcceleratorTable *TABLE)
  1259.  
  1260.  - Function: void gtk_window_remove_accelerator_table (GtkWindow
  1261.           *WINDOW, GtkAcceleratorTable *TABLE)
  1262.  
  1263.  - Function: void gtk_window_position (GtkWindow *WINDOW,
  1264.           GtkWindowPosition POSITION)
  1265.      Set the position that the window will be at when it is finally
  1266.      drawn to the screen. The POSITION argument effects the the
  1267.      position as described above.
  1268.  
  1269.  - Function: GtkWindow* GTK_WINDOW (gpointer OBJ)
  1270.      Cast a generic pointer to `GtkWindow*'. *Note Standard Macros::,
  1271.      for more info.
  1272.  
  1273.  - Function: GtkWindowClass* GTK_WINDOW_CLASS (gpointer CLASS)
  1274.      Cast a generic pointer to `GtkWindowClass*'. *Note Standard
  1275.      Macros::, for more info.
  1276.  
  1277.  - Function: gint GTK_IS_WINDOW (gpointer OBJ)
  1278.      Determine if a generic pointer refers to a `GtkWindow' object.
  1279.      *Note Standard Macros::, for more info.
  1280.  
  1281. 
  1282. File: gtk.info,  Node: Other Objects,  Next: Miscellaneous,  Prev: Widgets,  Up: Top
  1283.  
  1284. Utility objects
  1285. ***************
  1286.  
  1287. * Menu:
  1288.  
  1289. * GtkAcceleratorTable::         The accelerator table object.
  1290. * GtkAdjustment::               The adjustment object.
  1291. * GtkGC::                       The GC object.
  1292. * GtkData::                     The data object.
  1293. * GtkStyle::                    The style object.
  1294.  
  1295. 
  1296. File: gtk.info,  Node: GtkAcceleratorTable,  Next: GtkAdjustment,  Prev: Other Objects,  Up: Other Objects
  1297.  
  1298. The accelerator table object
  1299. ============================
  1300.  
  1301. Description
  1302. -----------
  1303.  
  1304. Functions
  1305. ---------
  1306.  
  1307.  - Function: GtkAcceleratorTable* gtk_accelerator_table_new (void)
  1308.  
  1309.  - Function: GtkAcceleratorTable* gtk_accelerator_table_find (GtkObject
  1310.           *OBJECT, gchar *SIGNAL_NAME, guchar ACCELERATOR_KEY, guint8
  1311.           ACCELERATOR_MODS)
  1312.  
  1313.  - Function: GtkAccelerator *gtk_accelerator_table_ref
  1314.           (GtkAcceleratorTable *TABLE)
  1315.  
  1316.  - Function: void gtk_accelerator_table_unref (GtkAcceleratorTable
  1317.           *TABLE)
  1318.  
  1319.  - Function: void gtk_accelerator_table_install (GtkAcceleratorTable
  1320.           *TABLE, GtkObject *OBJECT, gchar *SIGNAL_NAME, guchar
  1321.           ACCELERATOR_KEY, guint8 ACCELERATOR_MODS)
  1322.  
  1323.  - Function: void gtk_accelerator_table_remove (GtkAcceleratorTable
  1324.           *TABLE, GtkObject *OBJECT, gchar *SIGNAL_NAME)
  1325.  
  1326.  - Function: void gtk_accelerator_table_check (GtkAcceleratorTable
  1327.           *TABLE, guchar ACCELERATOR_KEY, guint8 ACCELERATOR_MODS)
  1328.  
  1329.  - Function: void gtk_accelerator_table_set_mod_mask
  1330.           (GtkAcceleratorTable *TABLE, guint8 MODIFIER_MASK)
  1331.  
  1332. 
  1333. File: gtk.info,  Node: GtkAdjustment,  Next: GtkGC,  Prev: GtkAcceleratorTable,  Up: Other Objects
  1334.  
  1335. The adjustment object
  1336. =====================
  1337.  
  1338. Description
  1339. -----------
  1340.  
  1341. Functions
  1342. ---------
  1343.  
  1344.  - Function: guint gtk_adjustment_get_type (void)
  1345.      Returns the `GtkAdjustment' type identifier.
  1346.  
  1347.  - Function: GtkObject* gtk_adjustment_new (gfloat VALUE, gfloat LOWER,
  1348.           gfloat UPPER, gfloat STEP_INCREMENT, gfloat PAGE_INCREMENT,
  1349.           gfloat PAGE_SIZE)
  1350.  
  1351.  - Function: GtkGtkAdjustment* GTK_ADJUSTMENT (gpointer OBJ)
  1352.      Cast a generic pointer to `GtkGtkAdjustment*'. *Note Standard
  1353.      Macros::, for more info.
  1354.  
  1355.  - Function: GtkGtkAdjustmentClass* GTK_ADJUSTMENT_CLASS (gpointer
  1356.           CLASS)
  1357.      Cast a generic pointer to `GtkGtkAdjustmentClass*'. *Note Standard
  1358.      Macros::, for more info.
  1359.  
  1360.  - Function: gint GTK_IS_ADJUSTMENT (gpointer OBJ)
  1361.      Determine if a generic pointer refers to a `GtkGtkAdjustment'
  1362.      object. *Note Standard Macros::, for more info.
  1363.  
  1364. 
  1365. File: gtk.info,  Node: GtkGC,  Next: GtkData,  Prev: GtkAdjustment,  Up: Other Objects
  1366.  
  1367. The GC object
  1368. =============
  1369.  
  1370. Description
  1371. -----------
  1372.  
  1373. Functions
  1374. ---------
  1375.  
  1376.  - Function: GdkGC* gtk_gc_get (gint DEPTH, GdkColormap *COLORMAP,
  1377.           GdkGCValues *VALUES, GdkGCValuesMask VALUES_MASK)
  1378.  
  1379.  - Function: void gtk_gc_release (GdkGC *GC)
  1380.  
  1381. 
  1382. File: gtk.info,  Node: GtkData,  Next: GtkStyle,  Prev: GtkGC,  Up: Other Objects
  1383.  
  1384. The data object
  1385. ===============
  1386.  
  1387. Description
  1388. -----------
  1389.  
  1390. Functions
  1391. ---------
  1392.  
  1393.  - Function: guint gtk_data_get_type (void)
  1394.      Returns the `GtkData' type identifier.
  1395.  
  1396.  - Function: GtkData* GTK_DATA (gpointer OBJ)
  1397.      Cast a generic pointer to `GtkData*'. *Note Standard Macros::, for
  1398.      more info.
  1399.  
  1400.  - Function: GtkDataClass* GTK_DATA_CLASS (gpointer CLASS)
  1401.      Cast a generic pointer to `GtkDataClass*'. *Note Standard Macros::,
  1402.      for more info.
  1403.  
  1404.  - Function: gint GTK_IS_DATA (gpointer OBJ)
  1405.      Determine if a generic pointer refers to a `GtkData' object. *Note
  1406.      Standard Macros::, for more info.
  1407.  
  1408. 
  1409. File: gtk.info,  Node: GtkStyle,  Prev: GtkData,  Up: Other Objects
  1410.  
  1411. The style object
  1412. ================
  1413.  
  1414. Description
  1415. -----------
  1416.  
  1417. Functions
  1418. ---------
  1419.  
  1420. 
  1421. File: gtk.info,  Node: Miscellaneous,  Next: Examples,  Prev: Other Objects,  Up: Top
  1422.  
  1423. Initialization, exit and other features
  1424. ***************************************
  1425.  
  1426. * Menu:
  1427.  
  1428. * Initialization and exit::     Initializing and exiting GTK.
  1429. * Customization::               Customizing the library.
  1430. * Menu Factories::              Simplified menu creation.
  1431. * Tree Factories::              Simplified tree creation.
  1432. * Tool Tips::                   Pop up help mechanism.
  1433. * Resource Files::              Resource files.
  1434. * Standard Macros::             Macros defined by all objects.
  1435.  
  1436. 
  1437. File: gtk.info,  Node: Initialization and exit,  Next: Customization,  Prev: Miscellaneous,  Up: Miscellaneous
  1438.  
  1439. Initializing and exiting GTK
  1440. ============================
  1441.  
  1442. Initializing
  1443. ------------
  1444.  
  1445.    Before any GTK functions can be utilized the library must be
  1446. initialized. This can be accomplished by calling the `gtk_init'
  1447. function. The arguments you pass to this function should be the same
  1448. arguments that were passed to your application. This function will
  1449. parse the arguments that it understands and handle initializing the GDK
  1450. library for you.
  1451.  
  1452. Exiting
  1453. -------
  1454.  
  1455. Functions
  1456. ---------
  1457.  
  1458.  - Function: void gtk_init (int *ARGC, char **ARGV)
  1459.      Function to initialize GTK and GDK for you. This function will
  1460.      remove any command line arguments from ARGC and ARGV that it
  1461.      understands.
  1462.  
  1463.           int main (int argc, char *argv[])
  1464.           {
  1465.              ...Any local variables or non GTK/GDK initialization
  1466.           
  1467.              /* Initialize GTK. */
  1468.              gtk_init(&argc, &argc);
  1469.           
  1470.           }
  1471.  
  1472.  - Function: void gtk_exit (int ERROR_CODE)
  1473.      Exit GTK and perform any necessary cleanup. `gtk_exit' will call
  1474.      the systems `exit' function passing ERROR_CODE as the parameter.
  1475.  
  1476.  - Function: gint gtk_events_pending (void)
  1477.      Returns the number of events pending on the event queue.
  1478.  
  1479.  - Function: void gtk_main (void)
  1480.  
  1481.  - Function: guint gtk_main_level (void)
  1482.  
  1483.  - Function: void gtk_main_quit (void)
  1484.      A call to this function will cause the `gtk_main' function to exit,
  1485.      thereby allowing your application to exit.
  1486.  
  1487. 
  1488. File: gtk.info,  Node: Customization,  Next: Menu Factories,  Prev: Initialization and exit,  Up: Miscellaneous
  1489.  
  1490. Customization of the library
  1491. ============================
  1492.  
  1493. Description
  1494. -----------
  1495.  
  1496.    Like other X-windows applications the GTK library provides a way for
  1497. the user and application programmer to change the colors of just about
  1498. any widget.  You can also specify what pixmap should be tiled onto the
  1499. background of some widgets. All this is handled through a similar
  1500. method as in the standard X-windows environment, through the use of
  1501. 'rc' files. The format and functions available in these files is
  1502. discussed below.
  1503.  
  1504. Functions
  1505. ---------
  1506.  
  1507.    The following functions are available to handle the rc files.
  1508.  
  1509.  - Function: void gtk_rc_parse (char *FILENAME)
  1510.      This function will parse the FILENAME that is passed to it as its
  1511.      argument. It will use the style settings for the widget types
  1512.      defined there.
  1513.  
  1514.  - Function: void gtk_rc_init (void)
  1515.      This function will initialize the rc file parser, normally this
  1516.      need not be called directly as the `gtk_rc_parse' function will
  1517.      handle this for you.
  1518.  
  1519. 
  1520. File: gtk.info,  Node: Menu Factories,  Next: Tree Factories,  Prev: Customization,  Up: Miscellaneous
  1521.  
  1522. Simplified menu creation
  1523. ========================
  1524.  
  1525. 
  1526. File: gtk.info,  Node: Tree Factories,  Next: Tool Tips,  Prev: Menu Factories,  Up: Miscellaneous
  1527.  
  1528. Simplified tree creation
  1529. ========================
  1530.  
  1531. 
  1532. File: gtk.info,  Node: Tool Tips,  Next: Resource Files,  Prev: Tree Factories,  Up: Miscellaneous
  1533.  
  1534. Pop up help mechanism
  1535. =====================
  1536.  
  1537. Description
  1538. -----------
  1539.  
  1540. 
  1541. File: gtk.info,  Node: Resource Files,  Next: Standard Macros,  Prev: Tool Tips,  Up: Miscellaneous
  1542.  
  1543. Resource Files
  1544. ==============
  1545.  
  1546. 
  1547. File: gtk.info,  Node: Standard Macros,  Prev: Resource Files,  Up: Miscellaneous
  1548.  
  1549. Macros defined by all objects
  1550. =============================
  1551.  
  1552.    There are three macros that are defined by all object types. The
  1553. first two are used for performing casts and the last is for querying
  1554. whether an object is of a particular type. These macros are both
  1555. conveniences and debugging tools. If the GTK library was compiled with
  1556. `NDEBUG' defined as a preprocessor symbol (via the -DNDEBUG to cc),
  1557. then the macros check the object type and emit a warning if the cast is
  1558. invalid. Doing such checking is fairly expensive since the cast macros
  1559. are used everywhere in GTK and would normally be turned off in a public
  1560. release of a product. Note: The functions below are indeed macros, but
  1561. they may be considered functions for most purposes.
  1562.  
  1563.  - Function: Gtk<ObjectType>* GTK_<OBJECT_TYPE> (gpointer OBJ)
  1564.      Cast a generic pointer to `Gtk<ObjectType>*'. This function is
  1565.      provided in order to be able to provide checking during development
  1566.      stages of code development since it is possible to examine the
  1567.      actual type of object (using `gtk_type_is_a') before performing
  1568.      the cast.
  1569.  
  1570.  - Function: Gtk<ObjectType>Class* GTK_<OBJECT_TYPE>_CLASS (gpointer
  1571.           CLASS)
  1572.      Cast a generic pointer to `Gtk<ObjectType>Class*'. Like
  1573.      `GTK_<ObjectType>', this function is, in reality, a macro.
  1574.  
  1575.  - Function: gint GTK_IS_<ObjectType> (gpointer OBJ)
  1576.      Determine if a generic pointer refers to a `Gtk<ObjectType>'
  1577.      object. This function is, in reality, a macro wrapper around the
  1578.      `gtk_type_is_a' function (*note Types::.).
  1579.  
  1580. 
  1581. File: gtk.info,  Node: Examples,  Next: Object Implementation,  Prev: Miscellaneous,  Up: Top
  1582.  
  1583. Using GTK
  1584. *********
  1585.  
  1586. * Menu:
  1587.  
  1588. * Simple::                      The simplest GTK program.
  1589. * Hello World::                 Hello world in GTK.
  1590. * Hello World II::              An enhanced hello world.
  1591. * Hello World III::             Making Hello World II robust.
  1592.  
  1593. 
  1594. File: gtk.info,  Node: Simple,  Next: Hello World,  Prev: Examples,  Up: Examples
  1595.  
  1596. The simplest GTK program
  1597. ========================
  1598.  
  1599.    The 16 line GTK program shown below is just about the simplest
  1600. possible program which uses GTK. (Well, technically, you don't have to
  1601. create the window and it would still be a program which uses GTK). The
  1602. program, when compiled and run, will create a single window 200x200
  1603. pixels in size. The program does not exit until its is explicitly
  1604. killed using the shell or a window manager function.
  1605.  
  1606.      #include <gtk/gtk.h>
  1607.      
  1608.      int
  1609.      main (int argc, char *argv[])
  1610.      {
  1611.        GtkWidget *window;
  1612.      
  1613.        gtk_init (&argc, &argv);
  1614.      
  1615.        window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
  1616.        gtk_widget_show (window);
  1617.      
  1618.        gtk_main ();
  1619.      
  1620.        return 0;
  1621.      }
  1622.  
  1623.    The first point of interest in this program is the standard
  1624. initialization line.
  1625.  
  1626.        gtk_init (&argc, &argv);
  1627.  
  1628.    Almost every GTK program will contain such a line. GTK will
  1629. initialize itself and GDK and remove any command line arguments it
  1630. recognizes from ARGC and ARGV.
  1631.  
  1632.    The next two lines of code create and display a window.
  1633.  
  1634.        window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
  1635.        gtk_widget_show (window);
  1636.  
  1637.    The `GTK_WINDOW_TOPLEVEL' argument specifies that we want the window
  1638. to undergo window manager decoration and placement. One might be lead
  1639. to think that the window, since it has no children, would be 0x0 pixels
  1640. in size. But, this is not the case because a window that has no
  1641. children defaults to 200x200 pixels in size. Mainly because 0x0 windows
  1642. are annoying to manipulate or even see in some cases.
  1643.  
  1644.    The last line enters the GTK main processing loop.
  1645.  
  1646.        gtk_main ();
  1647.  
  1648.    Normally, `gtk_main' is called once and the program should exit when
  1649. it returns. *Note Initialization and exit::.
  1650.  
  1651.